@vtmn/css-dropdown
Decathlon Design System - Vitamin specific CSS styles for text input component
Install package
After installing npm or yarn, you can install @vtmn/css-dropdown
with this command:
npm i -S @vtmn/css-dropdown
yarn add @vtmn/css-dropdown
Or you can also install it with a CDN like unpkg.com
:
<link rel="stylesheet" href="https://unpkg.com/@vtmn/css-dropdown" />
Install fonts
Roboto & Roboto Condensed fonts as described in Typography section will not be automatically loaded. Fortunately, there is a few easy ways to get started.
You can install them with FontSource:
npm i -S @fontsource/roboto @fontsource/roboto-condensed
yarn add @fontsource/roboto @fontsource/roboto-condensed
Then, within your app entry file or site component, import it in:
import '@fontsource/roboto';
import '@fontsource/roboto/400.css';
import '@fontsource/roboto/400-italic.css';
In order to enhance performance of your app, please read about font subsetting. FontSource explains it here.
Otherwise, you can also load them through CDN:
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap"
/>
Finally, you can also import them via CSS import:
@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap');
Install icons (optional)
If you need to display icons, you will need to install @vtmn/icons
package.
npm i -S @vtmn/icons
yarn add @vtmn/icons
Then follow instructions in README of @vtmn/icons :
import '@vtmn/icons/dist/vitamix/font/vitamix.css';
Or you can also import it with a CDN like unpkg.com
with this file.
Usage
Once you have installed this package, you just have to import CSS styles!
With a bundler that supports CSS imports in JS files:
import '@vtmn/css-dropdown/dist/index.css';
Otherwise include it in your HTML file:
<link
rel="stylesheet"
href="./node_modules/@vtmn/css-dropdown/dist/index.css"
/>
Development
To know all the use cases and their associated code, check out the showcase here.
Documentation
For more information about how this component is designed and how to use it in your application, check out the decathlon.design docs
Base 10 support
If your project uses the mathematical trick of basing the value of 1rem
equals 10px
, there is also an index-base10
output within the dist
folder of this package.
Changelog
If you want to know the different changes between versions of this package, look at the changelog here.
I have an issue, what should I do?
Please file the issue here.
Contributing
See the contributing docs.
License
Apache-2.0 © Decathlon